home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / comunic / zcomm.zip / ZCOMMDOC.AH < prev    next >
Text File  |  1993-11-27  |  74KB  |  1,771 lines
  1.  
  2.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  3.       ZCOMM User Manual                                                  211
  4.  
  5.          EXAMPLE: pm12 Causes file uploading to pause on FormFeed (FF).
  6.  
  7.       n  Set the normal display attribute.  The default of 7 gives a normal
  8.          white on black display.  The numbers associated with the s, r, and
  9.          n are stored in the attribute byte of each character position
  10.          written in the corresponding mode.
  11.  
  12.          The bit configuration (color display) is: Blink R G B  Intensity R
  13.          G B with the leftmost the most significant.
  14.  
  15.          Users with color monitors often use 2 (green) to avoid color
  16.          fringes caused by misconverged color monitors.
  17.          NOTE: the actual writing color attribute is not changed until the
  18.          next time the display is reset.  Some attributes generate
  19.          unreadable displays.  Other attributes generate text that can only
  20.          be seen on some monitors.
  21.  
  22.          EXAMPLE: pn3 sets cyan; pn2 sets green.
  23.  
  24.  
  25.       o  Iff non zero, allows overlap of file writing and incoming data from
  26.          the remote.  This increases throughput when receiving files with B,
  27.          Extended Quick B, XMODEM, and YMODEM protocols.  ZCOMM sets this to
  28.          1 on startup unless a PC-jr is detected.
  29.  
  30.       p  Pause sets the echo wait period (in hundredths of seconds) used
  31.          with the pattern command and the w and p term options.  Larger
  32.          numbers give longer pauses.  The default works well with most micro
  33.          based bulletin board systems.  The p parameter is reset to its
  34.          default of 70 (700 milliseconds approximately) by the call command.
  35.  
  36.          SEE ALSO: p term option
  37.  
  38.       q  Sets the "gopause".  When sending a file with a wait for "gochar" (
  39.          p term option), ZCOMM waits Gopause hundredths of seconds AFTER it
  40.          receives the "gochar".  The q parameter also controls the time
  41.          delay after a normal pattern match or putw command.
  42.  
  43.          The q parameter is reset to its default of 70 (700 milliseconds
  44.          approximately) by the call command.  The default value allows time
  45.          for immediate echoes to be displayed and for the Hayes
  46.          SmartModem(TM) to respond to most commands.
  47.  
  48.          SEE ALSO: p term option
  49.  
  50.       r  Set the attribute for "reverse video".
  51.  
  52.          EXAMPLE: pr97 sets "reverse video" to blue on yellow.
  53.  
  54.          Adding 1024 to this parameter forces ANSI SGR 7 to use this color.
  55.  
  56.  
  57.  
  58.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  59.  
  60.  
  61.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  62.       ZCOMM User Manual                                                  212
  63.  
  64.          SEE ALSO: n numeric parameter
  65.  
  66.       s  Set the attribute of the status line display (default 7, for
  67.          white).  A value of 8 (grey) may be chosen to prevent the status
  68.          line display from distracting from the information being printed.
  69.          The low intensity grey also minimizes phosphor burn.  Some other
  70.          possibilities are 2 for green, and 1 for blue (or underlined on the
  71.          monochrome board).
  72.  
  73.          SEE ALSO: n numeric parameter
  74.  
  75.       t  Sets the throttle speed (delay between characters in hundredths of
  76.          seconds) used by the term function when uploading files with an f
  77.          -t file command.  Throttle controls the term function sending speed
  78.          only when t term option is enabled.
  79.  
  80.          The default value of 4 corresponds to about 20 characters per
  81.          second.  Larger numbers give slower transmission.  The effective
  82.          resolution of the t parameter is limited by the timekeeping
  83.          resolution of the operating system; on PC-DOS the resolution is
  84.          about 18 per second.
  85.  
  86.          A negative value (-1 to -32767) may be used to specify a software
  87.          timing loop, with more negative values giving slower transmission.
  88.          The speed effect of a negative t value depends on the processor
  89.          speed and operating environment.
  90.  
  91.          The t parameter is reset to its default by the call command.
  92.  
  93.          SEE ALSO: t term option
  94.  
  95.       u  Sets the video attribute used to represent underline.
  96.  
  97.          EXAMPLE: pu14 sets "underline" to yellow.
  98.  
  99.          Adding 1024 to this parameter forces ANSI SGR 3 or 4 to use this
  100.          color.
  101.  
  102.          SEE ALSO: n numeric parameter
  103.  
  104.       v  Sets the verbose level (default 0).  A value less than zero
  105.          inhibits some routine messages.  A value og 1 or greater enables
  106.          logging of files skipped by selective ZMODEM file transfers.  A
  107.          value greater then zero causes the set command to list all string
  108.          parameters, including empty string parameters.  The screen erase
  109.          after data calls in host operation is disabled.  Values greater
  110.          than 1 display script commands as they are fetched from the script
  111.          file.* Larger values give more detailed tracing information.  A
  112.          value of 50+ causes data read by the read command to be displayed
  113.          and acted upon by the term function (when called) as if it had
  114.          arrived from the remote.
  115.  
  116.  
  117.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  118.  
  119.  
  120.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  121.       ZCOMM User Manual                                                  213
  122.  
  123.          NOTE: A v parameter value greater than zero affects scripts that
  124.          generate files with the > command.
  125.  
  126.       w  Controls the block length used by the CompuServe B Protocol.  A
  127.          longer length increases throughput, but may overload some networks,
  128.          resulting in excessive retransmissions or failed transfers.  The
  129.          maximum B+ block length is 1024 data bytes.  A value of 0 (the
  130.          default) allows the Compuserve computer to control the block
  131.          length.  A negative value controls the upload block length but
  132.          still allows Compuserve to control the download block length.
  133.          Uploads to Compuserve using longer block lengths are sensitive to
  134.          poor flow control, especially when error correcting modems (MNP,
  135.          etc.) are used.  If B+ uploads fail or require excessive
  136.          retransmissions, correct the flow control arrangements, disable the
  137.          modem's error correction, or try a smaller upload block size.
  138.  
  139.          The data contents of successfully transferred files are not
  140.          affected by this parameter.
  141.  
  142.       x  Sets the port number linked with the link command.
  143.  
  144.          SEE ALSO: link command, y numeric parameter
  145.  
  146.       y  Sets the transmission speed used by the linked port.
  147.  
  148.          SEE ALSO: link command, x numeric parameter
  149.  
  150.       z  Set the timeZone in minutes behind GMT (Greenwich Mean Time).
  151.  
  152.          EXAMPLE: pz300 sets timezone 300 minutes behind GMT for EST.
  153.  
  154.  
  155.          EXAMPLE: pz480 sets timezone 480 minutes behind GMT for PST.
  156.  
  157.  
  158.          SEE ALSO: d numeric parameter, ZONE environment variable
  159.  
  160.       _  The _ numeric parameter controls the action taken by ZCOMM when a
  161.          fatal error (one that generates the "ZCOMM: Error..." message).
  162.          Any non zero value causes DTR to be dropped (disconnect the modem).
  163.          A value greater than 100 causes ZCOMM to exit to the operating
  164.          system.  The NUKE key does not invoke this processing.
  165.  
  166.          EXAMPLE: p_101
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  177.  
  178.  
  179.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  180.       ZCOMM User Manual                                                  214
  181.  
  182.       24.1  Kermit Numeric Parameters
  183.  
  184.       The Super-Kermit parameters control Kermit protocol transfers.  They
  185.       are set with the kermit px# command.  Their current values may be
  186.       displayed with a kermit p command.  These parameters rarely need
  187.       changing for most systems.  They can be changed in case of difficulty
  188.       with Kermit transfers, especially with mainframe programs or obscure
  189.       microcomputer Kermit impelementations.
  190.  
  191.       Certain of these parameters require character values expressed in
  192.       decimal.  The ASCII code chart in Chapter 37 gives the decimal value
  193.       of all ASCII characters.
  194.  
  195.       When transferring files with Kermit programs operating on IBM
  196.       mainframes with half duplex front ends, the kermit i parameter should
  197.       be set to 1, and the kermit s parameter set to the longest response
  198.       time expected, perhaps 45 seconds.
  199.  
  200.       EXAMPLE: kermit pi1;  kermit ps45
  201.  
  202.  
  203.       SEE ALSO: Kermit protocol in Chapter 13
  204.  
  205.       7 If non zero, force seven bit line transmission with eighth bit
  206.         quoting Kermit transmission even if ZCOMM is otherwise using eight
  207.         bits no parity.  This parameter is reset by the call command.
  208.  
  209.       8 If non zero, force 8 bit transparent Kermit transmission even if
  210.         ZCOMM is otherwise using seven bit line transmission.  Normally, the
  211.         Kermit file transfer commands use 7 bit line transmission and
  212.         attempt to negotiate 8th bit quoting if one of the 7 bit term
  213.         options (7e, 7o, 7m, 7s) is used.  This parameter is reset by the
  214.         call command.
  215.  
  216.       a Incoming packet-start character, default 1 (SOH).
  217.  
  218.       A Outgoing packet-start character, default 1 (SOH).
  219.  
  220.       b Block check type requested: 1=1 byte checksum, 2=2 byte checksum,
  221.         3=3 byte CRC-16 (default).  Selecting a type 1 checksum instead of
  222.         type 3 will increase throughput by 2-4 percent[3] at the expense of
  223.         weaker error checking.  The probability of undetected errors when
  224.         using Kermit in checksum mode instead of CRC-16 increases
  225.         dramatically with noisy lines and longer packets.
  226.  
  227.  
  228.  
  229.       __________
  230.  
  231.        3. for 96 byte packets
  232.  
  233.  
  234.  
  235.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  236.  
  237.  
  238.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  239.       ZCOMM User Manual                                                  215
  240.  
  241.       c Control prefix in incoming data, default 35 (pound sign).
  242.  
  243.       C Control prefix in outgoing data, default 35 (pound sign).
  244.  
  245.       d Delay in seconds before initial sending, default 0.
  246.  
  247.       e Incoming end of line character, default 13 (CR).
  248.  
  249.       E Outgoing end of line character, default 13 (CR).
  250.  
  251.       i Use IBM line turnaround, default 0 (don't use IBM line turnaround).
  252.         The Kermit x numeric parameter sets the turnaround character.  This
  253.         may be necessary when communicating with IBM mainframes with half
  254.         duplex front ends.
  255.  
  256.       l Maximum outgoing packet length, default 1000, 1000 maximum.  A value
  257.         greater than 94 implies Kermit long packets.  The receiving program
  258.         may force shorter packets.
  259.  
  260.       L Maximum incoming packet length, default 1000, 1000 maximum.  A value
  261.         greater than 94 implies Kermit long packets.  This sets a limit; the
  262.         sending program may use shorter packets.
  263.  
  264.       p Sets the number of padding characters (default 0) to send before and
  265.         after each transmitted packet.
  266.  
  267.         SEE ALSO: kermit y numeric parameter
  268.  
  269.       r If non zero, remove incomplete files received with a protocol except
  270.         those received with the + option (default 0).
  271.  
  272.       s Timeout interval in seconds waiting for XON characters or positive
  273.         flow control (default 15).  If an XON is not received within this
  274.         time, transmission resumes anyway.  A value of 0 disables this
  275.         timeout.
  276.  
  277.       t Override timeout interval in seconds for incoming packets.  The
  278.         default of 0 allows the other program to specifiy the timeout.
  279.  
  280.       T Timeout interval for outgoing packets, default 4 seconds.
  281.  
  282.       v Eighth bit quoting character, default 38 (ampersand).  Sliding
  283.         Window size in Kermit packets, 1 minimum, 31 maximum, 15 default.
  284.         Setting w to zero disables the sliding window.
  285.  
  286.       x IBM turnaround character, default 17 (XON).
  287.  
  288.       y Pad character to send, default 0 (NUL).
  289.  
  290.         SEE ALSO: kermit p numeric parameter
  291.  
  292.  
  293.  
  294.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  295.  
  296.  
  297.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  298.       ZCOMM User Manual                                                  216
  299.  
  300.       24.2  X/Y/ZMODEM Numeric Parameters
  301.  
  302.       These parameters control XMODEM, YMODEM, and ZMODEM protocol
  303.       transfers.  They are set with the z px# command available with ZMODEM
  304.       flavors of ZCOMM.
  305.  
  306.       EXAMPLE: z pl16384
  307.       Forces ZMODEM packet length of 16384 (default packet length is
  308.       infinite).
  309.  
  310.       Their current values can be displayed with a z p command.  These
  311.       parameters rarely need changing in normal environments.
  312.  
  313.       b If non zero, ZMODEM sends a break when it is sending a file and
  314.         receives a retransmission request.  This mode of operation may be
  315.         used with high speed modems to clear unwanted characters from the
  316.         modem's buffer during error recovery.  Usually, the modem must be
  317.         given a configuration command to make it clear its transmit buffer
  318.         when receiving a break signal.
  319.  
  320.       B Sets the duration of the break signal in tenths of a second, default
  321.         2 (200 milliseconds).
  322.  
  323.       c Enables Cybernetic Data Recovery(TM) on XMODEM and YMODEM transfers.
  324.         Setting this parameter to 0 accommodates programs with non standard
  325.         XMODEM/YMODEM protocols and slightly quickens file transfers.  The
  326.         default value of 1 provides optimum reliability for XMODEM and
  327.         YMODEM transfers with programs that meet the XMODEM/YMODEM spec.
  328.  
  329.         Setting this parameter to -1 disables error checking provided by the
  330.         r option.
  331.  
  332.  
  333.       C Sets the number of times ZMODEM will attempt to send a command (as a
  334.         result of a zcommand command) (default 11).
  335.  
  336.       d Sets a delay time in tenths of seconds that the sz command will wait
  337.         for a ZMODEM packet in response to the rz<ENTER> string it sends to
  338.         the remote before sending a ZMODEM packet.  This facilitates
  339.         automatic ZMODEM uploads to VMS, which interrupts programs with the
  340.         Ctrl-X character.  The call command resets this parameter to its
  341.         default of 1.  Higher values increase the startup time when the
  342.         receiving ZMODEM program is started before the sender.
  343.  
  344.       e If non zero, escape all control characters.  This allows ZMODEM
  345.         transfers to operate over data PBX and other systems that freak out
  346.         when they receive control characters.
  347.  
  348.       d Some operating systems, most notably VAX/VMS, use ^X to stop
  349.         programs.  ZMODEM uploads consist of a "rz" command to start the rz
  350.         program followed by a ZMODEM packet.  If the ^X in the ZMODEM packet
  351.  
  352.  
  353.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  354.  
  355.  
  356.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  357.       ZCOMM User Manual                                                  217
  358.  
  359.         causes problems, the zmodem d parameter can be used to delay the
  360.         initial ZMODEM packet until the rz program initializes itself.  The
  361.         zmodem d parameter sets a delay in tenths of a second on ZMODEM
  362.         sends (uploads) between the "rz" command and the first packet.
  363.  
  364.       f Flow control mask, only used with Unix/Xenix systems.  Setting this
  365.         to 0 (the default) disables hardware (RTS/CTS) flow control for
  366.         Xenix/Unix systems with broken hardware flow control.  On Xenix/Unix
  367.         systems where only CTS flow control works properly, set this to 8192
  368.         to allow CTS flow control only.
  369.  
  370.         Use 32768 for newer SCO systems that support CRTSFL.
  371.  
  372.       F Sets the pause after each data subpacket sent with the sz command
  373.         when the F option is used, or when failing flow control is detected.
  374.         The default value of 1 causes a one tenth second delay.
  375.  
  376.         SEE ALSO: F option On some Unix operating systems the pause will be
  377.         rounded up to the next second or two.
  378.  
  379.       l Normally, the ZMODEM "packet length" ("block length") is the file
  380.         length.  Setting this parameter non zero forces ZMODEM to close a
  381.         frame and wait for an ACK after each # bytes (default 0).  This
  382.         makes ZMODEM behave like XMODEM, YMODEM, or JMODEM, which wait after
  383.         each block/packet for an acknowledgement before going on to the next
  384.         block.  The packet length may be adjusted to prevent buffer overflow
  385.         in data PBX systems.  The call command resets this parameter to 0.
  386.  
  387.       L (Default 0) If non zero, overrides the nominal length of data
  388.         subpackets within each ZMODEM frame.  A smaller value speeds error
  389.         recovery on noisy lines, a large value (maximum 1024) reduces the
  390.         overhead of CRC characters.  The call command resets this parameter
  391.         to 0.
  392.  
  393.         Please note that streaming ZMODEM has no direct equivalent to
  394.         XMODEM/YMODEM/JMODEM block length unless the zmodem l parameter is
  395.         set non zero.  In the absence of errors, ZMODEM normally sends the
  396.         entire file without pause.  If somebody claims ZMODEM's 1024 byte
  397.         subpacket length is slowing things down by more than one half per
  398.         cent, he doesn't understand ZMODEM and should be ignored.
  399.  
  400.       n Sets the number of NULLS (default 0) sent before each ZDATA frame.
  401.         Some buffered modems (Fastcomm) have a firmware bug which loses
  402.         characters when changing the direction of transmission.  This causes
  403.         data frames to fail with a CRC or other error.  ZMODEM n parameter
  404.         values in the range of 100 to 150 have obviated this syndrome.
  405.  
  406.       P When set to 2 (the default), purge the transmit buffer and force a
  407.         receiver response when a CR/LF sequence (indicating a PC-Pursuit
  408.         DATA LOSS message) is detected.  A value of 1 does not purge the
  409.         transmit buffer.  A value of 0 disables special processing of CR/LF
  410.  
  411.  
  412.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  413.  
  414.  
  415.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  416.       ZCOMM User Manual                                                  218
  417.  
  418.         sequences received by the sending ZMODEM.
  419.  
  420.       w If non 0, restrict the ZMODEM transmit window to the specified
  421.         number of bytes.  Setting this parameter to N requests
  422.         acknowledgements from the receiver every N/4 characters.  ZCOMM then
  423.         waits for acknowledgements from the receiver whenever it has sent N
  424.         more characters than it has received acknowledgements for.  This
  425.         parameter is useful with networks with defective flow control, and
  426.         with networks that store an excessive number of characters in
  427.         transit.  The call command resets this parameter to 0.
  428.  
  429.         Setting this parameter non zero also causes the sz command to
  430.         perform an extra step that actively prevents an ALT-F given to a
  431.         receiver from generating a spurious successful file transfer
  432.         completion.
  433.  
  434.       W Adjusts the number of characters the ZMODEM receiver will silently
  435.         ignore when searching for the beginning of a new frame.  This may be
  436.         set larger to accomodate networks with excessive in transit storage,
  437.         smaller to speed error recovery from long error bursts on direct
  438.         connections.  The call command resets this parameter to the default
  439.         (1400).
  440.  
  441.       Z Number of minutes (default 0) to adjust the file modification date
  442.         when using the Telink or Clink/SEAlink file transfer protocol to
  443.         transfer a file between different time zones.
  444.  
  445.       The timeout parameters below may be set lower for faster X/YMODEM
  446.       error recovery when transferring files between two micros, higher to
  447.       accomodate extremely sluggish systems.  Only in pathological cases is
  448.       it necessary to modify these parameters.  The call command resets
  449.       these parameter to their defaults.
  450.  
  451.       p Timeout in tenths of seconds for gaps within a packet (default 100).
  452.  
  453.       r If non zero, remove incomplete files received with a protocol except
  454.         those received with the + option (default 0).
  455.  
  456.       R When non 0, limits the number of bytes of file comparision used with
  457.         the sz and rz -rr option.  This parameter may be set to a value
  458.         between 2048 and 32000 (1 billion on 32 bit systems).  This
  459.         parameter is given to the receiving program.
  460.  
  461.         EXAMPLE: z pR30000
  462.  
  463.  
  464.         SEE ALSO: -rr option
  465.  
  466.       s Timeout interval in seconds waiting for XON characters or positive
  467.         flow control (default 15).  If an XON is not received within this
  468.         time, transmission resumes anyway.  A value of 0 disables this
  469.  
  470.  
  471.       (C) 1993 Omen Tech Inc                   Chapter 24 Numeric Parameters
  472.  
  473.  
  474.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  475.       ZCOMM User Manual                                                  219
  476.  
  477.         timeout.
  478.  
  479.       t XMODEM, YMODEM, and ZMODEM Receiver timeout in tenths of seconds
  480.         waiting for a packet or command acknowledgement (default 100).
  481.  
  482.       T Transmitter timeout in tenths of seconds waiting for a packet
  483.         (default 600).
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.       (C) 1993 Omen Tech Inc                    Chapter 24 String Parameters
  531.  
  532.  
  533.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  534.       ZCOMM User Manual                                                  220
  535.  
  536.       25.  STRING PARAMETERS
  537.  
  538.       Case is significant in parameter names.
  539.  
  540.       ZCOMM provides two types of string parameters, permament and
  541.       temporary.  Permanent string parameters are always defined, and most
  542.       perform specific defined functions.  The permanent string parameters
  543.       are described below.  The names of the permament string parameters may
  544.       be displayed with the command sequence pv1; set given at the command
  545.       prompt.  Without the pv1 only non empty string parameters are
  546.       displayed.
  547.  
  548.       Temporary string parameters* are created by the set, sets, accept, and
  549.       grab commands when they do not reference a permament string parameter.
  550.       Temporary string parameter names begin with any letter except y and
  551.       may have up to 16 letters or digits.
  552.  
  553.       The contents of temporary string parameters may be accessed and
  554.       modified when ZCOMM is Restricted.  New temporary string parameter
  555.       names may not be created when ZCOMM is Restricted.
  556.  
  557.       The set command without arguments displays the current values and
  558.       maximum string length for each of the non-empty string parameters.  To
  559.       set a parameter empty, enter "" as the parameter string (e.g., set
  560.       txlog "").  Certain string parameters may be entered with ZCOMM's
  561.       character escapes.
  562.  
  563.       When a string parameter is executed, it may be either sent to the
  564.       remote as a string or executed as a command if its first character is
  565.       @.
  566.  
  567.       EXAMPLE: set f7 "logout\r" programs F7 to send a string to the remote.
  568.  
  569.  
  570.       EXAMPLE: set f7 "@echo logout" programs F7 to display logout on the
  571.       screen.
  572.  
  573.  
  574.       In strings sent to the remote, a \336 (octal 336) character causes a
  575.       pause in transmission[1] (controlled by the p numeric parameter),
  576.       which may be used to send multiple commands with one string.
  577.  
  578.       An optional underscore prepended to the name of a permament string
  579.       parameter causes that string parameter to be cleared by the next call
  580.       command.
  581.  
  582.  
  583.       __________
  584.  
  585.        1. Not including the mput command
  586.  
  587.  
  588.  
  589.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  590.  
  591.  
  592.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  593.       ZCOMM User Manual                                                  221
  594.  
  595.       String parameters may be up to 129 characters in length except as
  596.       noted.  TAB characters count as one character each.
  597.  
  598.       The following string parameters may not be accessed or modified by the
  599.       set command or in string expansions when ZCOMM is Restricted:
  600.           alta...altz backtab bbs break bs esc etx exrc f1...f12 fs1...fs12
  601.           fc1...fc12 fa1...fa12 fcdel* fcdown* fcend* fchome* fcins* fcleft*
  602.           fcpgdn* fcpgup* fcright* fcup* fdel fdown fhome fins fleft fnp5*
  603.           fpgdn fpgup fright fup id0...id3 intolink* l linkpass* m oncloserx
  604.           onclosetx onexit outahost outalink* password pw0...pw3 quitcmd rub
  605.           tab unrestrict xpassword*
  606.  
  607.       The following may not be modified by the set command when ZCOMM is
  608.       restricted:
  609.           MODEM answerback altprompt baudstr blankfill call1** call2 call3*
  610.           callers* calllog* callpath** cellular challenge dircx dirpx dirfx
  611.           dirrx dirsx disks dport e emdir entstr eolstr helpfile home
  612.           hprompt lib lpnono mcommand mconnect menu messages mprefix mprompt
  613.           msuffix n1 n2 n3 phones picture plog private rcmdlog* rdisks
  614.           remote rname* rxlog* telno tmp tname* twxfile txlog* welcome
  615.           xhelpfile
  616.  
  617.       The following parameters can never be modified by the set command: ano
  618.           args c d drive e h nodename oname1...oname5 parity pwd s speed t w
  619.           y y0...y127 yb yf
  620.  
  621.       String Parameters for Remote Operation:
  622.           answerback baudstr bbs call1** call2 call3* callers callpath**
  623.           cellular challenge dircx dirfx dirrx dirsx disks emdir exrc
  624.           helpfile home hprompt intolink* linkpass* menu messages oncloserx
  625.           onclosetx outahost outalink* password private pwd rcmdlog* rdisks
  626.           rmtcmd* rname* rmtcheck* tname* twxfile unrestrict welcome
  627.           xhelpfile
  628.       String Parameters for Protocol File Transfer:
  629.           adlopts aulopts dirrx dirsx oncloserx onclosetx
  630.       String Parameters for Non Protocol File Transfer:
  631.           blankfill dircx dirfx eolstr toptions
  632.       String Parameters for Interactive Operation:
  633.           Soft Keys altprompt backtab break bs dirpx entstr esc etx lpnono
  634.           mprompt parity rub tab toptions xpassword*
  635.       String Parameters for Scripts:
  636.           ano args c d e h ifs item lib oncloserx onclosetx onexit nodename
  637.           oname1...oname5 remote rxcnt s s0...s9 t tmp toptions y y0...y127
  638.           yb yf
  639.       String Parameters for Making Calls:
  640.           MODEM l m mcommand mconnect mprefix msuffix telno
  641.       String Parameters for Log Keeping:
  642.           callers* calllog* plog rcmdlog* rxlog* txlog*
  643.       Other String Parameters:
  644.           helpfile home kermreset menu onexit picture phones quitcmd
  645.  
  646.  
  647.  
  648.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  649.  
  650.  
  651.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  652.       ZCOMM User Manual                                                  222
  653.  
  654.       MODEM    (Note this variable name is UPPER CASE to allow importing
  655.                from the environment.) When the advanced dialer described in
  656.                Chapter 8 is used, MODEM contains the file name of the modem
  657.                specific dial routine to use.
  658.  
  659.       adlopts  Contains option(s) to be used for ZMODEM AutoDownloads.
  660.  
  661.                EXAMPLE: set adlopts "r" Use the r option (crash recovery)
  662.                for files automatically downloaded with ZMODEM.
  663.  
  664.       alds     An optional string to be used for controlling Alternate Long
  665.                Distance Services.  On Unix systems, allows assignments to
  666.                the ALT keys a to z.
  667.  
  668.       ano      After invoking one of the date related string parameters, the
  669.                ano string contains the last two digits of the year.
  670.  
  671.       answerback When term is in q (TWX) term option, an answerback is sent
  672.                in response to an incoming ENQ.  The format of Answerback is
  673.                determined by the Western Union Telegraph Company.  It
  674.                typically consists of \r\nNAME CITY\r\n\021 as entered by the
  675.                set command using character escapes.  (In the TWX protocol,
  676.                the 021 (XON) at the end of the answerback turns on the tape
  677.                reader.) The answerback string must begin with CR,LF.
  678.  
  679.       args     contains the complete calling sequence to the current script
  680.                level.
  681.  
  682.                EXAMPLE: call ge,upl accesses the genie telephone directory
  683.                entry and stores ge.upl in args.
  684.  
  685.  
  686.       altprompt Overrides the default auxilliary command prompt generated by
  687.                the ALT-2 key.
  688.  
  689.                EXAMPLE: set altprompt "\r\E[1m%drive:\L%pwd >>>\E[m "
  690.                Display the current disk drive (%c) and directory (%pwd)
  691.                highlighted (\E[1m) and in lower case (\L).
  692.  
  693.                N.B.: If you access Unix systems with ZCOMM, choose an
  694.                altprompt string that is distinct from your Unix prompt.
  695.  
  696.                SEE ALSO: hprompt, mprompt, nodename, drive, pwd string
  697.                parameters
  698.  
  699.       aulopts  Contains option(s) to be used with the sz command.  aulopts
  700.                is processed by the sz command before any options given to
  701.                the command itself.
  702.  
  703.       backtab  Assigns a string or command to the BACKTAB (Shift TAB) key.
  704.  
  705.  
  706.  
  707.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  708.  
  709.  
  710.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  711.       ZCOMM User Manual                                                  223
  712.  
  713.       baudstr  When ZCOMM gets a connect in host operation, ZCOMM executes
  714.                baudstr.
  715.  
  716.                EXAMPLE: set baudstr "@gosub .%lib/baud.t"
  717.  
  718.  
  719.                SEE ALSO: host operation, Chapter 28
  720.  
  721.       bbs      May contain a shell escape command to activate a Bulletin
  722.                Board program via a DOS Gateway.  The bbs string parameter is
  723.                always processed as a shell escape command, and should not
  724.                include a leading "!".  For security reasons, it should
  725.                specify an absolute pathname.
  726.  
  727.                EXAMPLE: set bbs "~bbsprog"
  728.  
  729.  
  730.       blankfill When transmitting a file with the term function with p, r,
  731.                or w term options, ZCOMM sends the contents of blankfill (if
  732.                set) to prevent the remote from receiving a blank (empty)
  733.                line.  (Some programs interpret a blank line as an exit from
  734.                text entry.) ZCOMM Character Escapes must be used to
  735.                represent control characters.  If blankfill is empty, nothing
  736.                is sent. The call command resets blankfill to empty.
  737.  
  738.       break    Stores a string or command to be executed by the Ctrl-Break
  739.                key instead of the default 100 ms break.
  740.  
  741.                EXAMPLE: Some Novation modems cannot pass a break signal:
  742.                  set break "@break putw %B\336\ 1\r putw %U\336\ 0\r"
  743.                Causes the break key to send a break to get the modem's
  744.                attention, then tells the modem to send the break itself, and
  745.                finally restores
  746.  
  747.                the modem's ersatz "transparent" mode.
  748.  
  749.                SEE ALSO: break command
  750.  
  751.       bs       Stores an alternate string or command to be executed by the
  752.                backspace key when in the term function.
  753.  
  754.       c        When the h or s string parameters is accessed, the hundredths
  755.                of a second are stored in the c string parameter.  The
  756.                accuracy and precision of this quantity depend on the
  757.                operating environment.
  758.  
  759.       call1    ** Sets the string to be sent to the modem or command to be
  760.                executed before each time ZCOMM scans for outgoing message
  761.                control scripts.  Typically this would consist of a modem
  762.                command disabling autoanswer, to allow outgoing calls.  This
  763.                string is not used if callpath is empty.
  764.  
  765.  
  766.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  767.  
  768.  
  769.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  770.       ZCOMM User Manual                                                  224
  771.  
  772.                EXAMPLE: set call1 "ATMS0=0\r" (Hayes Modem)
  773.  
  774.  
  775.       call2    Sets the string to be sent to the modem or command to be
  776.                executed each time ZCOMM begins to wait for a call in Host
  777.                State.  Typically this would command the modem to enable
  778.                autoanswer for incoming calls.
  779.  
  780.                EXAMPLE: set call2 "ATMS0=1\r" (Hayes Modem)
  781.  
  782.  
  783.       call3    * Sets the string to be sent to the modem or command to be
  784.                executed each time ZCOMM begins waiting for incoming calls.
  785.                Typically this would consist of a lput command to display an
  786.                informational message on the local screen.  Note that such a
  787.                message will remain on the screen for long periods of time,
  788.                possibly creating an afterimage on the CRT display.
  789.  
  790.                EXAMPLE: set call3
  791.                @lput "\n\nAwaiting Incoming Call.  Press F1 to exit.\n"
  792.  
  793.  
  794.       callers  A pathname in which a log of successful host state logins is
  795.                kept.  If callers is null (the default), no log is kept.
  796.  
  797.                SEE ALSO: Chapter 30, Logging Entries
  798.  
  799.       calllog  * The filename that contains the log of successful autodialed
  800.                calls.  If empty (the default), this function is disabled.  A
  801.                typical entry with 6.3 minutes connect time with a system
  802.                called cis02 is shown.  The phone number is that given to
  803.                Zcomm for autodialing.
  804.                C 2143:22 01-25-84 1200 c:226-0627  63 cis02
  805.  
  806.                SEE ALSO: Chapter 30, Logging Entries
  807.  
  808.       callpath ** Sets the ambiguous pathname that scans for scripts to
  809.                transmit outgoing messages.  If empty (the default), no scans
  810.                are made.
  811.  
  812.                EXAMPLE: set callpath "/tmp/outmsg.*"
  813.  
  814.                NOTE: The "disks" string parameter must be set to include any
  815.                drive specified in "callpath".
  816.  
  817.                SEE ALSO: call1, call2 string parameters
  818.  
  819.       cellular This is set by a call cellular command to make the dialer
  820.                select modem options suitable for operation over cellular
  821.                radio.
  822.  
  823.  
  824.  
  825.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  826.  
  827.  
  828.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  829.       ZCOMM User Manual                                                  225
  830.  
  831.       challenge is executed when the caller connects and handshakes to
  832.                determine transmission speed.  This script runs without
  833.                restriction, and should check for carrier after each reading
  834.                of data.
  835.  
  836.                EXAMPLE: set challenge "@gosub .%lib/challeng.t"
  837.  
  838.  
  839.       d        Is set to the date when called, in the form "mmdd".
  840.  
  841.                EXAMPLE: t cia%d.TXT If the date is December 7, ZCOMM enters
  842.                the term function with capture to KGB1207.txt
  843.  
  844.  
  845.                EXAMPLE: create -st+ cbbs%d.tmp
  846.  
  847.  
  848.                SEE ALSO: h, t string parameters
  849.  
  850.       drive    Is set to the current default disk drive letter when ZCOMM
  851.                starts and when logging into a new disk drive with an A:
  852.                command.  nodename, altprompt, mprompt, hprompt string
  853.                parameters
  854.  
  855.       dircx, dirpx, dirfx, dirrx, dirsx String parameters for
  856.                default/override directories.  Their uses are described in
  857.                Chapter 16.
  858.  
  859.       disks    Contains the disks that may be logged into with with the d:
  860.                command where "d" is the drive letter, or that may appear as
  861.                part of a pathname.  If empty (the default), drive letters
  862.                are not checked.  This parameter should be set to prevent
  863.                local or remote users from hanging the system by accessing an
  864.                off-line disk drive.  This string must be entered in lower
  865.                case.
  866.  
  867.                EXAMPLE: set disks "abc"
  868.  
  869.  
  870.                SEE ALSO: home, rdisks string parameters
  871.  
  872.       dport    Contains the name of the active communications port,
  873.                otherwise empty.
  874.  
  875.                SEE ALSO: port command
  876.  
  877.       drive    Contains the drive letter of the current default DOS disk
  878.                drive.
  879.  
  880.       emdir    A directory pathname for incoming electronic mail files.
  881.                emdir affects twxfile unless twxfile is an absolute path.
  882.  
  883.  
  884.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  885.  
  886.  
  887.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  888.       ZCOMM User Manual                                                  226
  889.  
  890.                emdir is also used for incoming electronic mail using the
  891.                YMODEM Batch protocol in the absence of a login.
  892.  
  893.                EXAMPLE: set emdir "/memo"
  894.  
  895.  
  896.       entstr   If entstr is set, ZCOMM sends the contents of entstr when
  897.                ENTER (carriage return key) is keyboarded in the term
  898.                function, unless n term option is in effect.  ZCOMM Character
  899.                Escapes must be used to represent control characters.  If
  900.                entstr is empty, a carriage return is sent.  The "call"
  901.                command resets entstr to empty.
  902.  
  903.                EXAMPLE: set entstr "\3"
  904.  
  905.                sends an ETX (octal 3) when Enter is keyboarded.  This is
  906.                handy for some computer systems that expect keyboarded lines
  907.                to be terminated with something other than the usual carriage
  908.                return.
  909.                NOTE: The characters in entstr are always sent at full speed.
  910.  
  911.                SEE ALSO: eolstr string parameter
  912.  
  913.       eolstr   When transmitting a file with the term function with p, r, or
  914.                w term options, ZCOMM sends the contents of eolstr (if set)
  915.                to terminate the line.  ZCOMM Character Escapes must be used
  916.                to represent control characters.  If eolstr is empty, a
  917.                carriage return is sent. The "call" command resets eolstr to
  918.                empty.
  919.  
  920.                EXAMPLE: set eolstr "\r."
  921.  
  922.                sends a carriage return followed by a period at the end of
  923.                each line read from the transmit file.
  924.                NOTE: The characters in eolstr are always sent at full speed.
  925.  
  926.                SEE ALSO: entstr, blankfill string parameters
  927.  
  928.       esc      Stores an alternate string or command to be executed by the
  929.                ESC key when in term function.
  930.  
  931.       etx      Stores an alternate string or command to be executed by ETX
  932.                (Ctrl-C) when in the term function.
  933.  
  934.       exrc     Is sent to the modem/executed when an interactive Host
  935.                Operation session logs out.
  936.  
  937.                EXAMPLE: set exrc "@handshake off; set disks c" turns off
  938.                flow control handshaking and resets the disks parameter in
  939.                case privileged (unrestricted) callers modify this parameter.
  940.  
  941.  
  942.  
  943.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  944.  
  945.  
  946.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  947.       ZCOMM User Manual                                                  227
  948.  
  949.       h        is set to the hour of the day in the form hhmm.
  950.  
  951.                EXAMPLE: echo "It is now %h Hours"
  952.                displays: It is now 1930 Hours.
  953.  
  954.  
  955.                SEE ALSO: hh, mm, d, t string parameters
  956.  
  957.       helpfile The pathname that contains the online help file.  You may
  958.                wish to set this in the phone directory "setup" entry.  Iff
  959.                helpfile begins with the character @, the rest of helpfile is
  960.                treated as a Zcomm command.
  961.  
  962.                SEE ALSO: xhelpfile string parameters, help command, T test
  963.                condition
  964.  
  965.       hh       is set to the hour of the day in the form hh.
  966.  
  967.                EXAMPLE: echo "It is now hour %h."
  968.                displays: It is now hour 09.
  969.  
  970.  
  971.                SEE ALSO: h, mm, d, t string parameters
  972.  
  973.       home     When ZCOMM is invoked, home is set to the current directory.
  974.                When the "cd" command is given without an argument, the
  975.                directory is changed to the contents of home.  When ZCOMM is
  976.                Restricted, absolute pathnames (those beginning with \ or /)
  977.                must have home as a prefix.  This restricts unprivileged
  978.                users to the directory given in home and/or its
  979.                subdirectories on any of the disks allowed by the disks
  980.                string parameter.  When changing the value of home, use
  981.                slashes (/) and not backslases (\), and do not use a disk
  982.                identifier.
  983.  
  984.                SEE ALSO: disks string parameter
  985.  
  986.       hprompt  Overrides the default host operation command prompt.
  987.  
  988.                SEE ALSO: altprompt, mprompt, nodename, drive, pwd string
  989.                parameters
  990.  
  991.       id0-id3  General purpose string parameters that may be used to hold ID
  992.                strings (user account numbers) for script login applications.
  993.  
  994.       ifs      The "Internal Field Separator" string contains the default
  995.                characters to be used by the split command to parse a string
  996.                into fields.
  997.  
  998.       item     * When the expand command is executing a script, the item
  999.                string parameter is set to the pathname of the matched file.
  1000.  
  1001.  
  1002.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1003.  
  1004.  
  1005.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1006.       ZCOMM User Manual                                                  228
  1007.  
  1008.       intolink * A command that is executed or a string sent to the modem
  1009.                when ZCOMM enters the link command.
  1010.  
  1011.                EXAMPLE: set intolink "\r" sends CR to the linked computer.
  1012.  
  1013.  
  1014.                EXAMPLE: set intolink "@portx 0f8,2" selects a nonstandard
  1015.                link port.
  1016.  
  1017.                SEE ALSO: linkpass, outalink string parameters
  1018.  
  1019.       kermreset A string (up to 32 characters) may be sent by Pro-YAM's
  1020.                Kermit when it attempts to recover from a transmission error.
  1021.                The default value for this string is empty.  Two
  1022.                metacharacters are special: \336 inserts a one second pause,
  1023.                \335 sends a break.
  1024.  
  1025.       l        l (letter l) selects a long distance carrier for calls to
  1026.                other area codes.  It is set to "1" as a default.  l may be
  1027.                set to the access code of the particular alternate long
  1028.                distance service desired with a "set" command.
  1029.  
  1030.                SEE ALSO: m string parameter
  1031.  
  1032.       lib      A string variable which may be used to indicate the directory
  1033.                containing scripts.
  1034.  
  1035.       linkpass * If set, callers must enter this password when accessing the
  1036.                link command.
  1037.  
  1038.       lpnono   Do not send any of the characters in lpnono to the printer.
  1039.                lpnono may use ZCOMM Character Escapes to represent control
  1040.                characters.
  1041.  
  1042.                EXAMPLE: set lpnono "\023" prevents the printer from
  1043.                receiving the DC3 (XOFF) character that places some printers
  1044.                off line.
  1045.  
  1046.  
  1047.                EXAMPLE: set lpnono "\7" prevents the printing of bell
  1048.                characters.
  1049.  
  1050.  
  1051.                SEE ALSO: l mode
  1052.  
  1053.       m        m selects a long distance carrier for calls within the same
  1054.                area code.  It is set to "1" as a default.  m may be set to
  1055.                the access code of the particular alternate long distance
  1056.                service desired with a "set" command.  It is separate from
  1057.                the l string parameter because the default "1" prefix may not
  1058.                work if the area code is given, but some alternative long
  1059.  
  1060.  
  1061.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1062.  
  1063.  
  1064.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1065.       ZCOMM User Manual                                                  229
  1066.  
  1067.                distance services require the area code to be specified for
  1068.                calls within the same area code.
  1069.  
  1070.                SEE ALSO: l string parameter
  1071.  
  1072.       mcommand A command that is executed instead of ZCOMM's built in
  1073.                dialing routine.
  1074.  
  1075.                This may be either "gosub dial" which would access the "dial"
  1076.                entry in the phones file, or "source /dial" which would
  1077.                access the script from a separate file.  The second method
  1078.                allows a separate "dial" file for each machine, but requires
  1079.                one more file to be kept track of.
  1080.  
  1081.                Note that mcommand does not start with an @.  The default
  1082.                value is empty, disabling this function.
  1083.  
  1084.                EXAMPLE: set mcommand "gosub dial"
  1085.  
  1086.  
  1087.                SEE ALSO: telno string parameter
  1088.  
  1089.       mconnect A command that is executed or string that is sent to the
  1090.                modem when the modem makes a connection.  A typical use is to
  1091.                set transparent mode for some Novation modems.  The default
  1092.                value is empty, disabling this function.
  1093.  
  1094.       menu     The filename that contains the script accessed by the menu
  1095.                command.
  1096.  
  1097.                EXAMPLE: set menu /host/menu.hst
  1098.  
  1099.  
  1100.       messages Messages entered with the message command are appended to
  1101.                this pathname.  By convention, this file should be readable
  1102.                when ZCOMM is running in Restricted host mode.
  1103.  
  1104.                EXAMPLE: set messages "/host/messages"
  1105.  
  1106.  
  1107.       mprefix  A command that is executed or a string that is sent to the
  1108.                modem as a prefix to dialing a number.  The default ATD works
  1109.                with the Hayes Smartmodem(TM) 1200.  ATDT instructs the modem
  1110.                to use DTMF (Touch Tone(TM)) dialing instead of pulse
  1111.                dialing.  Character escapes may be used.
  1112.  
  1113.       mm       is set to the minute of the hour. It expands to the form mm.
  1114.  
  1115.                EXAMPLE: echo "It is now %h minutes past the hour"
  1116.                displays: It is now 30 minutes past the hour.
  1117.  
  1118.  
  1119.  
  1120.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1121.  
  1122.  
  1123.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1124.       ZCOMM User Manual                                                  230
  1125.  
  1126.                SEE ALSO: h, hh, d, t string parameters
  1127.  
  1128.       mprompt  Overrides the default main command prompt.
  1129.  
  1130.                EXAMPLE: set mprompt "\r\E[1m%drive:\L%pwd <<<\E[m "
  1131.                Display the current disk drive (%c) and directory (%pwd)
  1132.                highlighted (\E[1m) and in lower case (\L).
  1133.  
  1134.                N.B.: If you access Unix systems with ZCOMM, choose an
  1135.                mprompt string that is distinct from your Unix prompt.
  1136.  
  1137.                EXAMPLE: set mprompt "\r\E[1m%nodename:%drive:\L%pwd <<<\E[m
  1138.                "
  1139.  
  1140.  
  1141.                SEE ALSO: altprompt, hprompt, nodename, drive, pwd string
  1142.                parameters
  1143.  
  1144.       msuffix  A command that is executed or a string sent to the modem
  1145.                after the last digit in the phone number.  Most intelligent
  1146.                modems require the default value of "\r".
  1147.  
  1148.       n0-n9    General purpose string parameters.
  1149.  
  1150.       nodename Contains the node name given to individual Unix and Xenix
  1151.                systems.  On other systems this must be set by a script.
  1152.  
  1153.                SEE ALSO: Unix uname command
  1154.  
  1155.       oname1...oname5 contains the information stored by the args string
  1156.                parameter for each level.
  1157.  
  1158.       oncloserx Optional user exit commands to execute after each file is
  1159.                received with a protocol file transfer.* Its use is described
  1160.                in Chapter 13.
  1161.  
  1162.       onclosetx Optional user exit commands to execute after each file is
  1163.                sent with a protocol file transfer.* Its use is described in
  1164.                Chapter 13.
  1165.  
  1166.       onexit   Optional commands to execute as ZCOMM exits to the operating
  1167.                system.
  1168.  
  1169.                EXAMPLE: set onexit "@echo GOODBYE!!"
  1170.  
  1171.  
  1172.       outahost A command that is executed or a string sent to the modem when
  1173.                ZCOMM exits host operation with a F1 or ALT-N key.
  1174.  
  1175.                EXAMPLE: set outahost ATZ\r sends the ATZ command to a Hayes
  1176.                modem to restore its default no autoanswer state.
  1177.  
  1178.  
  1179.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1180.  
  1181.  
  1182.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1183.       ZCOMM User Manual                                                  231
  1184.  
  1185.       outalink * A command that is executed or a string sent to the modem
  1186.                when ZCOMM exits the link command.
  1187.  
  1188.                EXAMPLE: set outalink "@kill; px0" clears the circular buffer
  1189.                and prevents restricted callers from accessing the link
  1190.                command.
  1191.  
  1192.  
  1193.                SEE ALSO: intolink string parameter
  1194.  
  1195.       parity   Contains a string representation of the number of data bits
  1196.                and parity, such as 8n.
  1197.  
  1198.       password Changes the password callers must enter to gain access to
  1199.                your computer when ZCOMM is in host operation.  If password
  1200.                is empty no password will be demanded.
  1201.  
  1202.                EXAMPLE: set password "Change This Already"
  1203.  
  1204.  
  1205.                SEE ALSO: challeng.t script, demand command
  1206.  
  1207.       phones   The filename that contains the telephone directory entries
  1208.                and associated commands used with the call and gosub
  1209.                commands.  The default is "/PHODIR.t".  The default may be
  1210.                changed at installation time by the putsnp program.  The DOS
  1211.                environment variable PHONES will override the default when
  1212.                ZCOMM is started.  Finally, a set command may be used to
  1213.                change the telephone directory once ZCOMM has started.
  1214.  
  1215.       picture  The filename used by the ALT-Z command to "zap" a copy of the
  1216.                display memory to the specified file.
  1217.  
  1218.       plog     The filename that contains the file transfer performance log.
  1219.                If empty (the default), this function is disabled.
  1220.  
  1221.                SEE ALSO: Chapter 30, Logging Entries
  1222.  
  1223.       private  Pathname that messages are stored into by the private
  1224.                command.  This file should NOT be readable when ZCOMM is
  1225.                running in Restricted host mode.
  1226.  
  1227.                EXAMPLE: set private "/private"
  1228.  
  1229.  
  1230.       pw0-pw3  General purpose string parameters for holding passwords.  If
  1231.                defined with a set _pw0 "secretpw" command, it will be
  1232.                cleared with the next call command.
  1233.  
  1234.       pwd      This parameter is set to the current working directory by
  1235.                each cd and pwd command.
  1236.  
  1237.  
  1238.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1239.  
  1240.  
  1241.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1242.       ZCOMM User Manual                                                  232
  1243.  
  1244.       quitcmd  Sets the string to be sent to the modem or command to be
  1245.                executed when a protocol file transfer has been completed if
  1246.                the ALT-Q key was typed during that transfer.
  1247.  
  1248.                EXAMPLE: set quitcmd t\r\336\r\336\r\025off\r would send
  1249.                t<ENTER>, a pause, <ENTER>, a pause, <ENTER>, and
  1250.                ^Uoff<ENTER>.  This sequence may be useful for automatically
  1251.                logging off Compuserve after downloading a file.
  1252.  
  1253.  
  1254.                SEE ALSO: ALT-Q special key
  1255.  
  1256.       rcmdlog  * The filename that contains the log of commands issued
  1257.                remotely (in Host Operation) along with the time,
  1258.                transmission speed, and the name of the caller.  If set to
  1259.                "prn", the commands are logged on the printer.  A highly
  1260.                buffered printer, hard disk file or ramdisk file is
  1261.                recommended because this file will be opened and closed for
  1262.                each host command.  If empty (the default), this function is
  1263.                disabled.
  1264.  
  1265.                EXAMPLE: set rcmdlog D:rcmds
  1266.  
  1267.  
  1268.                SEE ALSO: Chapter 30, Logging Entries
  1269.  
  1270.       rdisks   Contains the disks that may be logged into with with the d:
  1271.                command where "d" is the drive letter, or that may appear as
  1272.                part of a pathname, when ZCOMM is Restricted.  If empty (the
  1273.                default), drive letters are not checked against this
  1274.                parameter.  (Drive letters are always checked with the disks
  1275.                parameter.) The rdisks parameter is used to prevent
  1276.                restricted remote users from accessing private data files.
  1277.                This string must be entered in lower case.
  1278.  
  1279.                EXAMPLE: set rdisks "c"
  1280.  
  1281.  
  1282.                SEE ALSO: home, disks string parameters
  1283.  
  1284.       remote   ZCOMM reads The full name of the remote system from the
  1285.                telephone directory entry when the call command is given.
  1286.  
  1287.                EXAMPLE: call omen using the omen entry in the distributed
  1288.                PHODIR.t file assigns omen-tech to the remote string
  1289.                parameter.
  1290.  
  1291.                In Host Operation, the caller's name is read into remote.
  1292.  
  1293.                SEE ALSO: call command, xpassword string parameter, \PXXXX
  1294.                character escape
  1295.  
  1296.  
  1297.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1298.  
  1299.  
  1300.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1301.       ZCOMM User Manual                                                  233
  1302.  
  1303.       rmtcheck Sets the string to be sent to the modem or command to be
  1304.                executed each time ZCOMM accepts a command line or ZMODEM
  1305.                protocol Command Download from the remote caller when in Host
  1306.                Operation, before that command is executed.
  1307.  
  1308.                SEE ALSO: rmtcmd, pwd string parameters
  1309.  
  1310.                EXAMPLE: set rmtcheck "@source D:remcheck.t"
  1311.  
  1312.  
  1313.       rmtcmd   Contains the command line entered by the caller or received
  1314.                by ZMODEM protocol Command Download in Host Operation.  This
  1315.                may be modified by an unrestricted script invoked via the
  1316.                rmtcheck string parameter.
  1317.  
  1318.                SEE ALSO: rmtcheck string parameter, checkrmt.t script
  1319.  
  1320.       rname    * Contains the name of the last file received by a protocol,
  1321.                successful or not.
  1322.  
  1323.       rub      Assigns a string or command to the RUBOUT (Shift Backspace)
  1324.                key.
  1325.  
  1326.       rxcnt    A three digit number which counts the number of files that
  1327.                have been created for receiving.  An incoming file with an
  1328.                illegal name is changed to rename.n with n is incremented
  1329.                from the value stored in rxcnt (or 0).
  1330.  
  1331.       rxlog    * The filename that contains the log of received files.  If
  1332.                empty (the default), this function is disabled.
  1333.  
  1334.                SEE ALSO: Chapter 30, Logging Entries
  1335.  
  1336.       s        * Contains the current time in seconds since the last minute.
  1337.  
  1338.       s0...s9  These may be tested with the if %sN and if i%sN,string
  1339.                commands, or expanded into a string using character escapes
  1340.                with the "%sN" construction, where N is 1...9.  Use set param
  1341.                "" (empty string enclosed by double quote characters) to set
  1342.                a string parameter to empty.
  1343.  
  1344.       speed    String representation of the serial port speed.
  1345.  
  1346.       statliner May be used to place a messgae in the right side of the term
  1347.                function status line, replacing the information normally
  1348.                displayed there.  If statliner begins with a space, it is
  1349.                placed at the far right of the status line, after the
  1350.                information normally displayed.  If statliner does not begin
  1351.                with a space, it is processed for string substitution and
  1352.                character escapes, and then placed at column 31 of the status
  1353.                line.
  1354.  
  1355.  
  1356.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1357.  
  1358.  
  1359.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1360.       ZCOMM User Manual                                                  234
  1361.  
  1362.       Soft Keys can either send strings or execute commands.  If the
  1363.                assigned string begins with "@" (commercial at), the string
  1364.                is executed as a command.
  1365.  
  1366.                A soft key command called from the term function should not
  1367.                end with a t or f command because this would cause excessive
  1368.                recursion (calling the term function from within the term
  1369.                function).  (Use the create or open instead.)
  1370.  
  1371.                The alta to altz, f1 to fa12 strings are executed by the
  1372.                respective keys from the term function, review function, or
  1373.                command prompt.  In the term function, soft keys definitions
  1374.                for fins, fdel, fhome, fup, fdown, fpgup, fpgdn, fleft,
  1375.                fright, fend will override ZCOMM's built-in definitions for
  1376.                these keys.  The built-in definitions take precedence in the
  1377.                review function, conference command, and at the command
  1378.                prompt.  In the conference command, soft keys are inserted
  1379.                into the editing window unless they are commands, which are
  1380.                executed.  Soft keys are not executed from review or the
  1381.                command prompt unless they are commands (beginning with "@").
  1382.  
  1383.                Computers with the 101 key extended keyboard and ROM BIOS
  1384.                support allow ZCOMM to distinguish the cursor cluster keys
  1385.                and the two new function keys labelled F11 and F12.  Extended
  1386.                keyboard cursor cluster keys may be reassigned with the
  1387.                fcdel, fcdown, fcend, fchome, fcins, fcleft, fcpgdn, fcpgup,
  1388.                fcright, and fcup string parameters.  The fnp5 key may be
  1389.                assigned to the "5" key on the numeric pad.[2] ZCOMM's
  1390.                character escapes can be used to encode special characters,
  1391.                including spaces and/or tabs.
  1392.  
  1393.                EXAMPLE: set bs "\177";  set rubout "\b" Swap backspace and
  1394.                rubout for VMS
  1395.  
  1396.  
  1397.                Bound Soft Keys are displayed by ALT-K and keys commands.
  1398.  
  1399.                EXAMPLE: set f3 @rb Assigns the rb command to F3.
  1400.  
  1401.  
  1402.       t        expands to the current time and date each time it is used.
  1403.  
  1404.                SEE ALSO: d, h string parameters
  1405.  
  1406.  
  1407.  
  1408.       __________
  1409.  
  1410.        2. Visible on extended 101 key keyboards with extended BIOS support
  1411.           only
  1412.  
  1413.  
  1414.  
  1415.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1416.  
  1417.  
  1418.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1419.       ZCOMM User Manual                                                  235
  1420.  
  1421.       tab      Assigns a string or command to the TAB key.
  1422.  
  1423.       telno    The current telephone number string.
  1424.  
  1425.                SEE ALSO: mcommand string parameter
  1426.  
  1427.       tmp      A string variable which may be used to indicate the directory
  1428.                used for data to be transmitted or received.
  1429.  
  1430.       tname    * Contains the name of the last file sent with a protocol,
  1431.                successful or not.
  1432.  
  1433.       toptions Contains optional term function options to be applied to each
  1434.                instance of the following term function commands: conference,
  1435.                create, f, learn, t and F-2
  1436.  
  1437.                SEE ALSO: term funcion options, Chapter 22.
  1438.  
  1439.       txlog    * The filename that contains the log of transmitted files.
  1440.                If empty (the default), this function is disabled.
  1441.  
  1442.                SEE ALSO: Chapter 30, Logging Entries
  1443.  
  1444.       unrestrict Changes the password callers must match to allow remote
  1445.                functions that are normally restricted such as erasing files,
  1446.                listing and changing parameters, and changing to private
  1447.                directories.  If unrestrict is empty (the default), the
  1448.                unrestrict command will fail.
  1449.  
  1450.                SEE ALSO: unrestrict command
  1451.  
  1452.       w        Contains the day of the week (local time) as Mon, Tue, Wed,
  1453.                Thu, Fri, Sat, or Sun.
  1454.  
  1455.       welcome  is executed after the password (if any) has been demanded and
  1456.                accepted.
  1457.  
  1458.                EXAMPLE: set welcome "@type welcome.txt; purgek; nulls 0"
  1459.  
  1460.  
  1461.       xhelpfile The pathname that contains the online help file for host
  1462.                mode commands.  This should be readable when ZCOMM is in
  1463.                Restricted Host Operation.  Iff xhelpfile begins with the
  1464.                character @, the rest of xhelpfile is treated as a Zcomm
  1465.                command.
  1466.  
  1467.                SEE ALSO: helpfile string parameters, help command
  1468.  
  1469.       xpassword * xpassword is a master password string that may be used to
  1470.                generate a unique password for each system called.  xpassword
  1471.                is encrypted by the name of the remote system (string
  1472.  
  1473.  
  1474.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1475.  
  1476.  
  1477.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1478.       ZCOMM User Manual                                                  236
  1479.  
  1480.                parameter remote) to generate a password unique to each
  1481.                remote system called.  The generated password is transmitted
  1482.                as a result of a Soft Key programmed with the \PXXXX
  1483.                construction described in Chapter 26.  To view the generated
  1484.                password, set the remote string parameter to the full remote
  1485.                system name as it appears in the appropriate telephone
  1486.                directory (up to but not including any "-" character), then
  1487.                keyboard lput \PXXXX from the main command prompt.
  1488.  
  1489.                EXAMPLE: set f8 "\PXXXX" Programs F8 to transmit a 5
  1490.                character password from the term function.
  1491.                Omen Technology Inc cannot accept responsibility for damages
  1492.                due to the breaking of any codes used or generated by ZCOMM.
  1493.  
  1494.       uucplock Contains an optional UUCP lock file prefix for arbitrating
  1495.                tty ports with the Unix UUCP program.  This is normally set
  1496.                automatically, or from the UUCPLOCK environment variable.
  1497.  
  1498.                EXAMPLE: set uucplock "/usr/spool/locks/LCK.."
  1499.  
  1500.  
  1501.       y        expands to represent the y string parameter current line.
  1502.  
  1503.       y0...y127 Read only string parameters y0 to y127 represent lines
  1504.                displayed by the term function.  y0 corresponds to the
  1505.                current partially finished line as displayed by the term
  1506.                function.  The last line referenced by y0...y127 becomes the
  1507.                y string parameter current line used by the y, yb, and yf
  1508.                string parameters.  Each time the term function displays a
  1509.                newline from the remote, the y string parameter current line
  1510.                points to the new, unfinished line from the remote.
  1511.  
  1512.       yb       Referencing the yb read only string parameter backs up the y
  1513.                string parameter current line one line, and then represents
  1514.                that line.
  1515.  
  1516.       yf       Referencing the yb read only string parameter advances the y
  1517.                string parameter current line one line, and then represents
  1518.                that line.
  1519.  
  1520.                SEE ALSO: H, h test conditions
  1521.  
  1522.       zmrxesc  Requests the sending ZMODEM-90(TM) program to escape the
  1523.                specified additional control character(s).  Printing
  1524.                characters @ (40 hex) to _ (57 hex) escape the corresponding
  1525.                control characters NULL (0) to US (1F) in both parities.
  1526.  
  1527.                EXAMPLE: set zmrxesc "@" Requests the sending program to
  1528.                escape NULL (0) and NULL with 8th bit set (80 hex).
  1529.  
  1530.                SEE ALSO: zmtxesc string parameter
  1531.  
  1532.  
  1533.       (C) 1993 Omen Tech Inc                    Chapter 25 String Parameters
  1534.  
  1535.  
  1536.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1537.       ZCOMM User Manual                                                  237
  1538.  
  1539.       zmtxesc  Causes ZMODEM send commands to escape the specified
  1540.                additional control character(s).  Printing characters @ (40
  1541.                hex) to _ (57 hex) escape the corresponding control
  1542.                characters NULL (0) to US (1F) in both parities.
  1543.  
  1544.                SEE ALSO: zmrxesc string parameter
  1545.  
  1546.  
  1547.  
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592.       (C) 1993 Omen Tech Inc                    Chapter 25 Character Escapes
  1593.  
  1594.  
  1595.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1596.       ZCOMM User Manual                                                  238
  1597.  
  1598.       26.  CHARACTER ESCAPES
  1599.  
  1600.       Some commands use strings with character escapes similar to those used
  1601.       by the C programming language for describing string constants.  When
  1602.       translating a string for character escapes, ZCOMM substitutes strings
  1603.       (%svar) and then translates the result for backslash (\) encoded
  1604.       character escapes.
  1605.  
  1606.               String-Parameter    %svar
  1607.               Environment-Param   %SVAR
  1608.               % (per cent)        \045
  1609.               password*           \PXXXXXXX
  1610.               cleartext*          \C+clear-text+
  1611.               ciphertext*         \M+ciphertext+
  1612.               newline (LF)        \n
  1613.               return (CR)         \r
  1614.               tab (HT)            \t
  1615.               alarm (BEL)         \a
  1616.               backspace (BS)      \b
  1617.               form feed (FF)      \f
  1618.               escape (ESC)        \E
  1619.               transparent         \T
  1620.               lowercase           \L
  1621.               uppercase           \U
  1622.               octal byte          \nnn
  1623.               decimal byte        \dnnn
  1624.               hex byte            \xHH
  1625.               control char        \^C
  1626.               concatenation       \&
  1627.               backslash           \\
  1628.  
  1629.       To preserve compatibility with future TurboDial enhancements, a
  1630.       backslash should not be followed by a character not listed above.
  1631.  
  1632.       %svar is replaced by the value of the corresponding string parameter.
  1633.       The string parameter name must be written exactly, in the correct
  1634.       case, with no extra letters or digits at the end.  Any non
  1635.       alphanumeric character delimits the parameter name.  The DOS
  1636.       environment is searched for parameters after exhausting the ZCOMM
  1637.       string parameters.[1]
  1638.  
  1639.       \PXXXXXXX uses the xpassword and remote string parameters to generate
  1640.       a password unique to each remote system, replacing each X character
  1641.       with an upper case alphabetic character.* The xpassword parameter must
  1642.       have at least as many characters as the number of characters used in
  1643.  
  1644.  
  1645.       __________
  1646.  
  1647.        1. DOS environment parameters are upper case only
  1648.  
  1649.  
  1650.  
  1651.       (C) 1993 Omen Tech Inc                    Chapter 26 Character Escapes
  1652.  
  1653.  
  1654.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1655.       ZCOMM User Manual                                                  239
  1656.  
  1657.       the \PXXXXX construction.
  1658.  
  1659.       SEE ALSO: xpassword, remote string parameters
  1660.  
  1661.       \M+ciphertext+ uses a cipher and the contents of the mpassword string
  1662.       parameter to decrypt and transmit the cleartext equivalent to
  1663.       ciphertext.  Ciphertext is delimited by the character immediately
  1664.       following "M".
  1665.  
  1666.       \C+cleartext+ is treated as above, except for no decryption.
  1667.  
  1668.       EXAMPLE: \C+foobar+ is translated to foobar by ZCOMM's character
  1669.       escape expansion.
  1670.  
  1671.  
  1672.       A separate program pga encrypts instances of \C+cleartext+ into
  1673.       \M+ciphertext+ according to a user specified master password.  Pga
  1674.       also decrypts \M sequences to either cleartext, or encrypts them with
  1675.       a new master password.  Please refer to Chapter 99.
  1676.  
  1677.       The \n, \r, \t, \b, \f, \E, \nnn, \xHH, \^C and \\ character escapes
  1678.       generate the associated character.
  1679.  
  1680.       The \T character escape inhibits the processing of character eascpes
  1681.       (but not string substitutions) in the remainder of the string.  It is
  1682.       useful when the raw string contains backslashes which must not be
  1683.       treated as character escapes.
  1684.  
  1685.       The \L character escape forces the rest of the string to lower case,
  1686.       up to the next \ character.  Likewise, \U forces upper case.
  1687.  
  1688.       Octal byte escapes (\nnn) accept 1 to 3 octal digits terminated by the
  1689.       first non octal digit.  Decimal byte escapes (\dnnn) accept 1 to 3
  1690.       digits terminated by the first non digit.  Hex byte escapes (\xHH)
  1691.       accept exactly 2 hex digits.  Control characters may also be
  1692.       represented by \^C where C is the printing representation for Ctrl-C
  1693.       and ^ is the circumflex character.
  1694.  
  1695.       The \& character escape generates nothing; it is useful to delimit the
  1696.       lexical end of a string parameter name in string concatenation
  1697.       applications.
  1698.  
  1699.  
  1700.       26.1  Concatenating String Parameters
  1701.  
  1702.       To concatenate the contents of a string parameter with other
  1703.       characters, one must escape the next character with a backslash if it
  1704.       is a letter or digit.  The \& character escape expands to nothing.
  1705.  
  1706.       EXAMPLE: Assume string parameter s1 contains "foo".
  1707.            putw "%s1\&bar"
  1708.  
  1709.  
  1710.       (C) 1993 Omen Tech Inc                    Chapter 26 Character Escapes
  1711.  
  1712.  
  1713.       Version 18.07 TurboDial 2.36            Universal Line Printer Edition
  1714.       ZCOMM User Manual                                                  240
  1715.  
  1716.       sends "foobar".
  1717.            putw "%s1\142bar"
  1718.       sends "foobbar".
  1719.            putw "%s1-skidoo"
  1720.       sends "foo-skidoo".
  1721.            putw "%s1bar"
  1722.       is undefined.
  1723.            putw "%s1\bar"
  1724.       sends "foo<BS>ar"
  1725.  
  1726.       Failure to observe this property causes the sets and put commands to
  1727.       give unexpected results.
  1728.  
  1729.       An encrypted password* is generated from the prototype string
  1730.       \PXXXXXXXX where each X generates an upper case alphabetic character
  1731.       by encrypting the leading letters of the remote system name by
  1732.       xpassword.
  1733.  
  1734.       Only the leading letters of the remote system name are used to allow a
  1735.       directory to have a number of alternate access methods for a given
  1736.       system, yet produce the same automatic password.  For example,
  1737.       "source", "source-telenet", "source300" would all generate the same
  1738.       password, but "sourceb" would generate a different password.
  1739.       xpassword must have at least as many characters as X characters in the
  1740.       prototype string.
  1741.  
  1742.       Omen Technology Inc and sellers of ZCOMM cannot accept any
  1743.       responsibility for damages due to the breaking of any ciphers used or
  1744.       generated by ZCOMM.
  1745.  
  1746.       An arbitrary byte is generated by backslash followed by one to three
  1747.       octal digits, backslash x followed by exactly two hex digits, or by
  1748.       backslash circumflex followed by three decimal digits.  7 bit term
  1749.       options (7s, 7m, 7e, 7o) modify the parity bit of characters
  1750.       transmitted by the term function during the put[w] command.
  1751.  
  1752.  
  1753.       26.2  Quoting Strings
  1754.  
  1755.       Strings must be enclosed by double quotes (Shift ' on the IBM Personal
  1756.       Computer) to allow white space and/or semicolon to be included in the
  1757.       string.  If a string containing white space were not quoted, it would
  1758.       be terminated by the first space or tab, and ZCOMM would consider the
  1759.       rest of the intended string as another (incorrect) command.
  1760.  
  1761.       26.3  Layering of Escaped Characters
  1762.  
  1763.       Sometimes a string will be processed two (or more) times by ZCOMM's
  1764.       character escapes.
  1765.  
  1766.            set fs2 "@accept s1 Name:; obey find\ \\n%s1\ %phones"
  1767.  
  1768.  
  1769.       (C) 1993 Omen Tech Inc                      Chapter 26 Quoting Strings
  1770.  
  1771.